Skip to content

Clean README and add Development.md for build/developer guidance#20

Merged
malhotra5 merged 1 commit intomainfrom
openhands/clean-readme-and-add-development-md
Sep 3, 2025
Merged

Clean README and add Development.md for build/developer guidance#20
malhotra5 merged 1 commit intomainfrom
openhands/clean-readme-and-add-development-md

Conversation

@malhotra5
Copy link
Collaborator

Summary

  • Rewrite README.md to be concise and action-oriented: quick uv install, local run instructions, and building/using the standalone executable.
  • Add Development.md with detailed contributor guidance: managing deps with uv/Poetry, PyInstaller spec usage with hiddenimports vs datas, local build and testing tips, and linting commands.

Why
The previous README accumulated unorganized agent notes across sessions. This change presents a clean, minimal Quickstart, and moves deeper developer content into a dedicated Development.md.

Changes

  • README.md:
    • Add Quickstart with uv install
    • Steps to run the CLI locally (make install-dev, make run)
    • Clear binary build and usage section (build.sh --install-pyinstaller, dist/ outputs)
    • Reference to Development.md for advanced details
  • Development.md:
    • How to add runtime and dev dependencies (uv and Poetry)
    • Spec file guidance including when to use hiddenimports vs datas
    • Build workflows (scripted and manual) and how to test the executable
    • Lint/format commands and credentials note

Testing

  • Ran make lint; all hooks passed (ruff, mypy, pyproject validation, etc.)
  • No application code changes; existing tests unaffected

Docs

  • README.md fully refreshed
  • New Development.md added

Linked issues

Notes

  • No PR template found in this repo; followed standard sections.

@malhotra5 can click here to continue refining the PR

…tions; add Development.md with detailed dev, packaging, and build guidance\n\nCloses #19\n\nCo-authored-by: openhands <openhands@all-hands.dev>
@malhotra5 malhotra5 added the documentation Improvements or additions to documentation label Sep 3, 2025 — with OpenHands AI
@malhotra5 malhotra5 merged commit e980c1a into main Sep 3, 2025
3 checks passed
@malhotra5 malhotra5 deleted the openhands/clean-readme-and-add-development-md branch September 9, 2025 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean agent comments from main readme

2 participants